home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2000 #4 / Amiga Plus CD - 2000 - No. 4.iso / Tools / Dev / Bgui / AutoDoc / aslreqclass.doc < prev    next >
Encoding:
Text File  |  2000-05-09  |  3.6 KB  |  167 lines
  1. TABLE OF CONTENTS
  2.  
  3. aslreqclass/--background--
  4. aslreqclass/ASLM_ALLOCREQUEST
  5. aslreqclass/ASLM_DOREQUEST
  6. aslreqclass/ASLM_FREEREQUEST
  7. aslreqclass/ASLM_REQUEST
  8. aslreqclass/OM_SET
  9. aslreqclass/ASLREQ_[Left,Top,Width,Height]
  10. aslreqclass/ASLREQ_Type
  11.  
  12. aslreqclass/--background--
  13.  
  14.     NAME
  15.     Class:        aslreqclass
  16.     Superclass:    rootclass
  17.     Include File:    <bgui/bgui_asl.h>
  18.  
  19.     FUNCTION
  20.     To  provide  a    BOOPSI    interface  class to all ASL requesters.  This
  21.     class  is  the  superclass  of  the  filereqclass,  fontreqclass  and
  22.     screenreqclass.  All ASL attributes are tracked by this class.
  23.  
  24.     This class is probably only directly useful to class implementors.
  25.  
  26.     NOTE
  27.     All  the  ASL requester attributes as defined in <libraries/asl.h> are
  28.     usable  with  this class.  Applicability for  these ASL  attributes is
  29.     (ISGU).
  30.  
  31.     SEE ALSO
  32.     <libraries/asl.h>
  33.  
  34. aslreqclass/ASLM_ALLOCREQUEST
  35.  
  36.     NAME
  37.     ASLM_ALLOCREQUEST -- Allocate the requester structure.
  38.  
  39.     FUNCTION
  40.     A low-level method, mainly useful to class implementors.  Allocates
  41.     and initializes the ASL requester, and returns a pointer to it, or
  42.     NULL if it fails to allocate the memory.
  43.     
  44.     SEE ALSO
  45.     ASLM_DOREQUEST, ASLM_REQUEST, ASLM_FREEREQUEST
  46.  
  47. aslreqclass/ASLM_DOREQUEST
  48.  
  49.     NAME
  50.     ASLM_DOREQUEST -- Popup the requester.
  51.  
  52.     SYNOPSIS
  53.     rc = DoMethod( obj, ASLM_DOREQUEST );
  54.  
  55.     ULONG        rc;
  56.  
  57.     FUNCTION
  58.     Sending this method to the object will open the requester.
  59.  
  60.     INPUTS
  61.     None.
  62.  
  63.     RESULT
  64.     rc    - Any of the following return codes:
  65.  
  66.         ASLREQ_OK -- Ok. No problems.
  67.  
  68.         ASLREQ_CANCEL -- The requester was cancelled by the user.
  69.  
  70.         ASLREQ_ERROR_NO_MEM -- Out of memory.
  71.  
  72.         ASLREQ_ERROR_NO_REQ -- It was not possible  for  the  object  to
  73.             allocate a requester structure.
  74.  
  75.     EXAMPLE
  76.     Object        *req;
  77.     ULONG         rc;
  78.  
  79.     /*
  80.      *    Open up a requester.
  81.      */
  82.     rc = DoMethod( req, ASLM_DOREQUEST );
  83.  
  84.     switch ( rc ) {
  85.         ...
  86.     }
  87.  
  88. aslreqclass/ASLM_FREEREQUEST
  89.  
  90.     NAME
  91.     ASLM_FREEREQUEST -- Allocate the requester structure.
  92.  
  93.     FUNCTION
  94.     A low-level method, mainly useful to class implementors.  Frees the
  95.     ASL requester if it was previously allocated.  No return value defined.
  96.     
  97.     SEE ALSO
  98.     ASLM_DOREQUEST, ASLM_ALLOCREQUEST, ASLM_REQUEST
  99.  
  100. aslreqclass/ASLM_REQUEST
  101.  
  102.     NAME
  103.     ASLM_REQUEST -- Open the requester.
  104.  
  105.     FUNCTION
  106.     A low-level method, mainly useful to class implementors.  Pops up the
  107.     ASL requester that was initialized by the ASLM_ALLOCREQUEST method.
  108.     Does not free the requester.
  109.     
  110.     This method will return FALSE on failure or cancellation, non-zero if
  111.     successful.
  112.  
  113.     A typical ASLM_DOREQUEST method looks like this:
  114.     
  115.         struct FileRequester *req;
  116.         
  117.         req = (struct FileRequester *)DoMethodA(obj, ASLM_ALLOCREQUEST);
  118.         
  119.         SetAttrsA(obj, myAslTags);    // Any tags you want to set
  120.         DoMethodA(obj, ASLM_REQUEST);
  121.         
  122.         strcpy(FileBuffer, req->fr_File);    // Get what you need
  123.         
  124.         DoMethodA(obj, ASLM_FREEREQUEST);    // Free it
  125.  
  126.     SEE ALSO
  127.     ASLM_DOREQUEST, ASLM_ALLOCREQUEST, ASLM_FREEREQUEST
  128.  
  129. aslreqclass/OM_SET
  130.  
  131.     NAME
  132.     OM_SET -- Set attributes.
  133.  
  134.     FUNCTION
  135.     Set attributes of the filerequester.  This method will return 0 if the
  136.     attributes were set OK. On  failure it will return ASLREQ_ERROR_NO_MEM
  137.     indicating that the change could not be made.
  138.  
  139. aslreqclass/ASLREQ_[Left,Top,Width,Height]
  140.  
  141.     NAME
  142.     ASLREQ_Left, ASLREQ_Top, ASLREQ_Width, ASLREQ_Height -- ( ULONG )
  143.  
  144.     FUNCTION
  145.     To obtain the current position and size of the filerequester.
  146.  
  147.     APPLICABILITY
  148.     (ISG).
  149.  
  150. aslreqclass/ASLREQ_Type
  151.  
  152.     NAME
  153.     ASLREQ_Type -- ( ULONG ) ** V40 **
  154.  
  155.     FUNCTION
  156.         To specify the type of ASL requester.  See <libraries/asl.h> for the
  157.         types available.
  158.  
  159.     DEFAULT
  160.     ASL_FileRequester.
  161.  
  162.     APPLICABILITY
  163.     (ISG).
  164.  
  165.     SEE ALSO
  166.     <libraries/asl.h>
  167.